API Docs for: 0.0.1
Show:

jsaEvenPhasor (Function) Class

Defined in: jsaSndLib\jsaOpCodes\jsaEventPhasor.js:19
Module: jsaEvenPhasor.js

Methods

(jsaEvenPhasor)

()

Defined in jsaSndLib\jsaOpCodes\jsaEventPhasor.js:27

Creates a phasor used to periodically trigger events

Returns:

Interface object for controlling the eventPhasor containing all the other methods in this module.

advance

(
  • interval
)
Number

Defined in jsaSndLib\jsaOpCodes\jsaEventPhasor.js:79

Advance the time rotating the phasor accorording to its frequency.

Parameters:

  • interval Number

    of time to advance

Returns:

Number:

current phase

advanceToTick

()

Defined in jsaSndLib\jsaOpCodes\jsaEventPhasor.js:103

Advances the time to that of next zero phase (which is when it "ticks")

advanceToTime

(
  • The
)
Number

Defined in jsaSndLib\jsaOpCodes\jsaEventPhasor.js:90

Set the time of the phasor rotating if from its current position as necessary

Parameters:

  • The Number

    time to advance the phasor to.

Returns:

Number:

current phase

getPhase

(
  • phase
)

Defined in jsaSndLib\jsaOpCodes\jsaEventPhasor.js:62

Get the current phse

Parameters:

  • phase Number

    in [0,1]

nextTickTime

() Number

Defined in jsaSndLib\jsaOpCodes\jsaEventPhasor.js:112

Advances the time to that of next zero phase (which is when it "ticks")

Returns:

Number:

time in sseconds

setCurrentTime

(
  • time
)

Defined in jsaSndLib\jsaOpCodes\jsaEventPhasor.js:44

Sets the time

Parameters:

  • time Number

    (in secs)

setFreq

()

Defined in jsaSndLib\jsaOpCodes\jsaEventPhasor.js:71

Sets the frequency that the phase will move (revolutions per second)

setPhase

(
  • phase
)

Defined in jsaSndLib\jsaOpCodes\jsaEventPhasor.js:53

Sets the phaser to a specific phase

Parameters:

  • phase Number

    in [0,1]

timeToTick

() Number

Defined in jsaSndLib\jsaOpCodes\jsaEventPhasor.js:124

Get the time between now and the next tick

Returns:

Number:

the amount of time until next tick